/*
 *  This file is part of VADER.
 *
 *  VADER is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  VADER is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package vegadataeditor.dataSources;

import java.util.List;
import vegadataeditor.VegaStreamContainer;



/**
 *
 * @author lawinslow
 */
public interface IDataSource {
    /**
     * Gets all the streams available in the database with attached metadata.
     * 
     * @return list of all streams available
     * @throws vegadataeditor.dataSources.SourceConnectionException 
     */
    public List<VegaStreamContainer> getAllStreams()throws SourceConnectionException;
    /**
     * Gets all the site names of sites available at this source.
     * 
     * @return list of site names in the databse
     * @throws vegadataeditor.dataSources.SourceConnectionException
     */
    public List<String> getSites()throws SourceConnectionException;
    /**
     * Gets all the variable names available at this source.
     *
     * @return list of all available variable names
     * @throws vegadataeditor.dataSources.SourceConnectionException
     */
    public List<String> getVariables()throws SourceConnectionException;
    /**
     * Fills the stream container with data for that stream during the
     * requested time period.
     * 
     * @param request the stream for which data are requested
     * @return the stream with the values and dates fields filled
     * @throws vegadataeditor.dataSources.SourceConnectionException
     */
    public VegaStreamContainer getData(VegaStreamContainer request)throws SourceConnectionException;




}
